

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>federatedml.statistic package &mdash; FATE 1.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
        <script type="text/javascript" src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> FATE
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"><ul>
<li><a class="reference internal" href="#">federatedml.statistic package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-federatedml.statistic.data_overview">federatedml.statistic.data_overview module</a></li>
<li><a class="reference internal" href="#module-federatedml.statistic.statics">federatedml.statistic.statics module</a></li>
<li><a class="reference internal" href="#module-federatedml.statistic">Module contents</a></li>
</ul>
</li>
</ul>
</div>
            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">FATE</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>federatedml.statistic package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/federatedml.statistic.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="federatedml-statistic-package">
<h1>federatedml.statistic package<a class="headerlink" href="#federatedml-statistic-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="federatedml.statistic.intersect.html">federatedml.statistic.intersect package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.intersect.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.intersect.html#federatedml-statistic-intersect-intersect-module">federatedml.statistic.intersect.intersect module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.intersect.html#federatedml-statistic-intersect-intersect-guest-module">federatedml.statistic.intersect.intersect_guest module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.intersect.html#federatedml-statistic-intersect-intersect-host-module">federatedml.statistic.intersect.intersect_host module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.intersect.html#federatedml-statistic-intersect-intersect-model-module">federatedml.statistic.intersect.intersect_model module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.intersect.html#module-contents">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="federatedml.statistic.test.html">federatedml.statistic.test package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.test.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.test.html#module-federatedml.statistic.test.statics_test">federatedml.statistic.test.statics_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.statistic.test.html#module-federatedml.statistic.test">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-federatedml.statistic.data_overview">
<span id="federatedml-statistic-data-overview-module"></span><h2>federatedml.statistic.data_overview module<a class="headerlink" href="#module-federatedml.statistic.data_overview" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="federatedml.statistic.data_overview.get_data_shape">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">get_data_shape</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#get_data_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.get_data_shape" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="federatedml.statistic.data_overview.get_features_shape">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">get_features_shape</code><span class="sig-paren">(</span><em>data_instances</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#get_features_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.get_features_shape" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="federatedml.statistic.data_overview.get_header">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">get_header</code><span class="sig-paren">(</span><em>data_instances</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#get_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.get_header" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="federatedml.statistic.data_overview.is_binary_labels">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">is_binary_labels</code><span class="sig-paren">(</span><em>data_instance</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#is_binary_labels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.is_binary_labels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="federatedml.statistic.data_overview.is_empty_feature">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">is_empty_feature</code><span class="sig-paren">(</span><em>data_instances</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#is_empty_feature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.is_empty_feature" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="federatedml.statistic.data_overview.is_sparse_data">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">is_sparse_data</code><span class="sig-paren">(</span><em>data_instance</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#is_sparse_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.is_sparse_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="federatedml.statistic.data_overview.rubbish_clear">
<code class="descclassname">federatedml.statistic.data_overview.</code><code class="descname">rubbish_clear</code><span class="sig-paren">(</span><em>rubbish_list</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/data_overview.html#rubbish_clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.data_overview.rubbish_clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Temporary procession for resource recovery. This will be discarded in next version because of our new resource recovery plan
Parameter
———-
rubbish_list: list of DTable, each DTable in this will be destroy</p>
</dd></dl>

</div>
<div class="section" id="module-federatedml.statistic.statics">
<span id="federatedml-statistic-statics-module"></span><h2>federatedml.statistic.statics module<a class="headerlink" href="#module-federatedml.statistic.statics" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary">
<em class="property">class </em><code class="descclassname">federatedml.statistic.statics.</code><code class="descname">MultivariateStatisticalSummary</code><span class="sig-paren">(</span><em>data_instances</em>, <em>cols_index=-1</em>, <em>abnormal_list=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="staticmethod">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.aggregate_statics">
<em class="property">static </em><code class="descname">aggregate_statics</code><span class="sig-paren">(</span><em>s_dict1</em>, <em>s_dict2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.aggregate_statics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.aggregate_statics" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_max">
<code class="descname">get_max</code><span class="sig-paren">(</span><em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_max"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_max" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_mean">
<code class="descname">get_mean</code><span class="sig-paren">(</span><em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_mean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_mean" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the mean value(s) of the given column</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cols_dict</strong> (<em>dict</em>) – Specify which column(s) need to apply statistic.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">return a dict of result mean.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_median">
<code class="descname">get_median</code><span class="sig-paren">(</span><em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_median"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_median" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_min">
<code class="descname">get_min</code><span class="sig-paren">(</span><em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_min"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_quantile_point">
<code class="descname">get_quantile_point</code><span class="sig-paren">(</span><em>quantile</em>, <em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_quantile_point"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_quantile_point" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the specific quantile point value</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>quantile</strong> (<em>float</em><em>, </em><em>0 &lt;= quantile &lt;= 1</em>) – Specify which column(s) need to apply statistic.</li>
<li><strong>cols_dict</strong> (<em>dict</em>) – Specify which column(s) need to apply statistic.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple">
<li><em>return a dict of result quantile points.</em></li>
<li><em>eg.</em></li>
<li><strong>quantile_point = {“x1”</strong> (<em>3, “x2”: 5… }</em>)</li>
</ul>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_std_variance">
<code class="descname">get_std_variance</code><span class="sig-paren">(</span><em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_std_variance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_std_variance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.get_variance">
<code class="descname">get_variance</code><span class="sig-paren">(</span><em>cols_dict=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.get_variance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.get_variance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="staticmethod">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.static_in_partition">
<em class="property">static </em><code class="descname">static_in_partition</code><span class="sig-paren">(</span><em>data_instances</em>, <em>cols_dict</em>, <em>abnormal_list</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.static_in_partition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.static_in_partition" title="Permalink to this definition">¶</a></dt>
<dd><p>Statics sums, sum_square, max and min value through one traversal</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data_instances</strong> (<em>DTable</em>) – The input data</li>
<li><strong>cols_dict</strong> (<em>dict</em>) – Specify which column(s) need to apply statistic.</li>
<li><strong>abnormal_list</strong> (<em>list</em>) – Specify which values are not permitted.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Dict of SummaryStatistics object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="federatedml.statistic.statics.MultivariateStatisticalSummary.static_summaries_in_partition">
<em class="property">static </em><code class="descname">static_summaries_in_partition</code><span class="sig-paren">(</span><em>data_instances</em>, <em>cols_dict</em>, <em>abnormal_list</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#MultivariateStatisticalSummary.static_summaries_in_partition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.MultivariateStatisticalSummary.static_summaries_in_partition" title="Permalink to this definition">¶</a></dt>
<dd><p>Statics sums, sum_square, max and min value through one traversal</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data_instances</strong> (<em>DTable</em>) – The input data</li>
<li><strong>cols_dict</strong> (<em>dict</em>) – Specify which column(s) need to apply statistic.</li>
<li><strong>abnormal_list</strong> (<em>list</em>) – Specify which values are not permitted.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Dict of SummaryStatistics object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="federatedml.statistic.statics.SummaryStatistics">
<em class="property">class </em><code class="descclassname">federatedml.statistic.statics.</code><code class="descname">SummaryStatistics</code><span class="sig-paren">(</span><em>abnormal_list=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#SummaryStatistics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.SummaryStatistics" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="federatedml.statistic.statics.SummaryStatistics.add_value">
<code class="descname">add_value</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#SummaryStatistics.add_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.SummaryStatistics.add_value" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="federatedml.statistic.statics.SummaryStatistics.mean">
<code class="descname">mean</code><a class="headerlink" href="#federatedml.statistic.statics.SummaryStatistics.mean" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.statistic.statics.SummaryStatistics.merge">
<code class="descname">merge</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/statistic/statics.html#SummaryStatistics.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.statistic.statics.SummaryStatistics.merge" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="federatedml.statistic.statics.SummaryStatistics.std_variance">
<code class="descname">std_variance</code><a class="headerlink" href="#federatedml.statistic.statics.SummaryStatistics.std_variance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="federatedml.statistic.statics.SummaryStatistics.variance">
<code class="descname">variance</code><a class="headerlink" href="#federatedml.statistic.statics.SummaryStatistics.variance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-federatedml.statistic">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-federatedml.statistic" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, FATE_TEAM

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>